Skip to content

🤖 fix: make nested API reference fields visually hierarchical#62

Merged
ThomasK33 merged 2 commits into
mainfrom
docs-j3x9
Feb 12, 2026
Merged

🤖 fix: make nested API reference fields visually hierarchical#62
ThomasK33 merged 2 commits into
mainfrom
docs-j3x9

Conversation

@ThomasK33

Copy link
Copy Markdown
Member

Summary

This PR improves generated API reference readability by rendering nested fields with explicit tree prefixes instead of invisible non-breaking-space indentation.

Background

We recently switched API docs to be more YAML-oriented, but nested structure was still hard to read in rendered markdown tables because indentation relied on   in table cells.

Implementation

  • Updated hack/crd-ref-docs/templates/markdown/gv_list.tpl:
    • Replaced    indentation with tree-style prefixes (├─, └─, ).
    • Added sibling-aware branch rendering so child rows show correct continuation lines.
  • Regenerated affected API docs:
    • docs/reference/api/codercontrolplane.md
    • docs/reference/api/coderprovisioner.md
    • docs/reference/api/workspaceproxy.md

Validation

  • make verify-vendor
  • make test
  • make build
  • make lint
  • make docs-build
  • make docs-reference

Risks

Low. This change only affects markdown template output and generated docs. Runtime code paths are unchanged.


Generated with mux • Model: openai:gpt-5.3-codex • Thinking: xhigh • Cost: $0.56

Replace non-breaking-space indentation in generated API reference tables with
visible tree prefixes (`├─`, `└─`, `│`) so nested fields are easier to scan.

Regenerated affected API reference docs with the updated template.

---

_Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.56`_

<!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.56 -->
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4d379065e5

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread hack/crd-ref-docs/templates/markdown/gv_list.tpl Outdated
Use non-collapsible spacing entities in recursive tree prefixes so deeper
last-child branches keep their visual nesting in markdown table renderers.

Regenerated affected API reference docs.

---

_Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.56`_

<!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.56 -->
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

Please take another look.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@ThomasK33 ThomasK33 added this pull request to the merge queue Feb 12, 2026
@ThomasK33

Copy link
Copy Markdown
Member Author

Merged via the queue into main with commit e8a597d Feb 12, 2026
11 checks passed
@ThomasK33 ThomasK33 deleted the docs-j3x9 branch February 12, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant